home *** CD-ROM | disk | FTP | other *** search
/ Animations / Animations CD.iso / c / hippoplayer.doc < prev    next >
Text File  |  1994-07-02  |  14KB  |  398 lines
  1. ******************************************************************************
  2. **                               HippoPlayer                                **
  3. *                    The Moduleplayer for smaller Amigas             *
  4. *                                         *
  5. *                  Programmed by K-P Koljonen (Moonstone/HPD)                *
  6. *                  - A Hippopotamus Design production 1994 -                 *
  7. *                                          *
  8. *                   This program may be freely distributed                   *
  9. *                 as long as all files are included unaltered!             *
  10. *                        Copyright © 1994 K-P Koljonen                     *
  11. **                                FREEWARE                                  **
  12. ******************************************************************************
  13.  
  14. HippoPlayer  (HiP)  is a moduleplayer for the Amiga.  It it works perfectly
  15. under Kickstart 1.2 and has about all the same features as the Multiplayer,
  16. which  is  Kick2.0+  only.  One main reason why I bothered myself by making
  17. this program was that there were no good Kick1.3 compatible players around.
  18. The  other  reason  was  that  my  good  friend Jarno Paananen (Guru/Sahara
  19. Surfers) made a replayroutine for Scream Tracker ]I[ modules.
  20.  
  21. Hip  is  the  best  Kickstart  1.2/1.3  moduleplayer  I've seen so far.  It
  22. doesn't  need over 100kb of disk space nor memory, and can't play dozens of
  23. weird  music  formats.   It  can  cope  with  some different music formats,
  24. though.   I have to mention, that the Protracker replayer in HiP is my own,
  25. and  quite  fast.   Average  rasterline usage (on A500) is 3 and maximum is
  26. 6-7.  Beat that ;-)...  HiP also supports multisong PT-modules (see below).
  27.  
  28. HiP  has  a good support for Scream Tracker ]I[, FastTracker, TakeTracker,
  29. and  MultiTracker  modules,  meaning  that you can listen them with a 68000
  30. Amiga  with  listenable  quality.  All are played by the famous replayer by
  31. Guru.
  32.  
  33.  
  34.  Some features:
  35.  · Scream Tracker ]I[, FastTracker, TakeTracker, MultiTracker, 1 to 32ch.
  36.  · The Player 6.0A. Samples may be packed, but not in a different file.
  37.  · TFMX modules, normal and the seven channel-ones
  38.  · Oktalyzer modules. Really good quality due to the turbocharged replayer.
  39.  · A handful of other 4 channel sample & synth music formats.
  40.  · Easy to use, nice 3D interface.
  41.  · Moduleprogram. Can be loaded and saved.
  42.  · Memory usage about 100kb.
  43.  · Loads and decompresses XPK, FImp and PowerPacker files.
  44.  · Internal multitasking.
  45.  · Tested and works on A500 running Kickstarts 1.2, 1.3 and 3.0.
  46.  
  47.  
  48. ****************
  49. * Requirements *
  50. ****************
  51.   Any Amiga with some memory and Kickstart 1.2 or higher.
  52.   Reqtools.library of any version will be needed for requesters.
  53.  
  54.   In order to decompress XPK or PowerPacker files, you will need
  55.   xpkmaster.library (with some sublibs) and powerpacker.library.
  56.   
  57.   For MED modules (4 channels), medplayer.library V2 or higher
  58.   will be required.
  59.  
  60.   These mentioned libraries are included in the package. Among them are
  61.   some XPK sublibs too. You should copy the desired libraries into your
  62.   LIBS: drawer. Note that only the reqtools.library is absolutely necessary.
  63.  
  64.   The program will run fine on 512kb Amigas but decompressing bigger files
  65.   may not work due to greater use of memory.
  66.  
  67.   HippoPlayer can be loaded from CLI or Workbench. An own process will
  68.   be created so there's no need to run it. This also means that you
  69.   mustn't merge hunks in the file.
  70.  
  71.   reqtools.library and powerpacker.library by Nico François.
  72.   medplayer.library by Teijo Kinnunen.
  73.  
  74. *****************
  75. * Music formats *
  76. *****************
  77.  Here's a list of the music formats in HippoPlayer and what functions
  78.  they support. Also the authors are listed.
  79.  
  80.  Stop/Continue    = 1 - The music can be stopped and continued at will.
  81.  Multiple songs   = 2 - Modules can have more than one song.
  82.  Volume          = 3 - Volume can be controlled.
  83.  End detect      = 4 - The end of the song can be detected.
  84.  Forward/backward = 5 - You can jump forwards and backwards in the song.
  85.  
  86.  Replayer            12345    Author
  87.  --------------------------------------------------------------------
  88.  BP SoundMon            x----    Brian Postma
  89.  Fred                xx---    JC & Frederic Hahn
  90.  Future Composer v1.0-v1.4    x-xx-    SuperSero (of the Superions)
  91.  JamCracker            x----    M. Gemmel
  92.  MED 4ch            x----    Teijo Kinnunen
  93.  Music Assembler        x-x--    Oscar Giesen & Marco Swagerman
  94.  Oktalyzer 8ch            --x--    Armin Sander
  95.  Protracker            xxxxx    K-P Koljonen
  96.  S3M/FTM/MOD/MTM        --x--    Jarno Paananen
  97.  SIDMon v1.0            x----    Reiner van Vliet
  98.  TFMX                xxx--    Chris Hülsbeck
  99.  TFMX 7ch            xx---    Chris Hülsbeck
  100.  The Player v6.0A        x-xx-    Jarno Paananen
  101.  
  102. Note  that  not  all  of the functions work on all replayers.  Eg you can't
  103. stop Oktalyzer when you've started it.  Well you can, but only by ejecting,
  104. so you can't continue.
  105.  
  106. Normally   all   modules   will   be   loaded   in  CHIP.   Oktalyzer-  and
  107. S3M/FTM/MOD/MTM  modules  and  TFMX  songdata will be loaded in FAST RAM if
  108. possible. 
  109. All  compressed  files  will  normally  be  loaded  in CHIP.  However, it's
  110. possible  to  uncompress some kilobytes from the beginning of a XPKed file,
  111. and  check if it is a S3M/FTM/MOD/MTM-, or PT module, which is to be passed
  112. to the mixing replayer, OR TFMX music data.  This slowes the loading down a
  113. bit,  but  speed  is gained because FAST is FASTer than CHIP.  This feature
  114. can be controlled from the prefs window.
  115.  
  116.  
  117. Protracker
  118. ----------
  119. There  are  some  modules  around  with  several  songs  separated by the B
  120. command.  HiP allows you to play these kind of modules correctly.  Just use
  121. the 'PS' and 'NS' gadgets to select different songs.
  122.  
  123. TFMX
  124. ----
  125. HiP  can  play  both  4 and 7 channel TFMX modules, including the excellent
  126. Turrican 2 and 3 intro tunes.
  127. A  TFMX module consists of two files.  They must be named 'mdat.<name>' and
  128. 'smpl.<name>'.   To  play, select 'mdat.<name>'.  HippoPlayer will then try
  129. to load the 'smpl.<name>' file.
  130.  
  131. The  mixing  rate  of  TFMX  7 channel replayer can be changed.  The bigger
  132. value, the better quality and bigger CPU load.
  133.   
  134. S3M/FTM/MOD/MTM
  135. ---------------
  136. (ScreamTracker ]I[/FastTracker/TakeTracker/MultiTracker)
  137.  
  138. Jarno  Paananen  (Guru/Sahara  Surfers)  has made replayers for these.  The
  139. mixing  routine is amazingly fast.  Even on Amiga 500 8 channel modules are
  140. very  listenable.   The  replayer  gobbles  quite  a bit of memory for it's
  141. buffers, so don't be surprised.
  142.  
  143. Mixing  rates  can be changed.  Again, the bigger value, the better quality
  144. and  bigger CPU load.  Using the system friendly mode on A500 will probably
  145. more  or less jam the machine, therefore you should use the killer mode for
  146. the best quality.
  147.  
  148. ***********
  149. * Gadgets *
  150. ***********
  151.  
  152.  New    Clear the modulelist, select new modules and play the first one.
  153.  
  154.  Play    Load and/or play the selected module. If nothing selected, pop up
  155.     the filerequester.
  156.  
  157.  Cont    Continue playing after stop.
  158.  
  159.  Stop    Stop playing.
  160.  
  161.  Eject    Stop playing and free the current module.
  162.  
  163.  Prev    Load and play previous module.
  164.  
  165.  Next    Load and play next module.
  166.  
  167.  PS    Play previous song.
  168.  
  169.  NS    Play next song.
  170.  
  171.  Add    Add modules to the end of the list, pop up the filerequester.
  172.  
  173.  Del    Delete the selected module from the list.
  174.  
  175.  Clr    Clear the list.
  176.  
  177.  <    Backward, jump to previous pattern.
  178.  
  179.  >    Forward, jump to next pattern.
  180.  
  181.  LoP    Load moduleprogram.
  182.  
  183.  SaP    Save moduleprogram.
  184.  
  185.  Prefs  Pop up the prefs window. You can also close it with this button.
  186.  
  187.  Vol    Volume controller (min=0, max=64).
  188.  
  189.  The leftmost propgadget
  190.     Scroll modulelist.
  191.  
  192.  ?    Enter the info menu.
  193.         Samplenames   Display samplenames of MODs, S3Ms, FTMs and
  194.                   MTMs.
  195.         Help          Description of gadgets.
  196.         More          More info..
  197.         Exit          ??
  198.  
  199.  Windowclose-button
  200.     Close all windows except requesters and exit.
  201.  
  202. *********
  203. * Prefs *
  204. *********
  205.  
  206. Mode (what to do when a module finishes)
  207. ----
  208.  Repeat        Play the modulelist over and over.
  209.  Through    Play the list once stop.
  210.  Repeat module    Play one module over and over.
  211.  Module        Play one module once and stop.
  212.  Random        "Shuffleplay". Play modules in random order.
  213.         When playing has started, same module will not be played twice
  214.                 unless all modules have been played.
  215.              
  216. The  'mode'  switch  affects the replayers where the end of the song can be
  217. detected from.
  218.  
  219. Show (titlebar information)
  220. ----
  221.  Time            Show playing time.
  222.  Songposition/length    Protracker only. You should know this.
  223.  Songnumber        Show current songnumber.
  224.  
  225. PT tempo (Protracker tempo command)
  226. -----------------------------------
  227. Enable  or  disable  Protracker tempo command.  This affects Protracker and
  228. the Player replayers.  Use on old modules that use speeds higher than $1F.
  229.  
  230. Filter
  231. ------
  232. Filter contolled by module, filter forced off or on.
  233.  
  234. Go - scopes
  235. -----------
  236. Select  one  of  the  four  scopes by clicking the larger gadget.  The 'Go'
  237. button  will  start it up.  You can close a scope by closing it's window or
  238. clicking  the  'Go'  again.   All the four scopes work only with Protracker
  239. modules.
  240.  
  241. Quadrascope (& bars)
  242.  - This is just like the one in Protracker, but has no bugs and is very
  243.    fast. Draws 4*80 pixels.
  244. Hipposcope (& bars)
  245.  - Couldn't invent a better name.. This is a nice one. Draws 4*104 pixels.
  246. Bars
  247.  - These will try to visualize the volume and the period of each channel.
  248.  
  249. The   original   quadrascope  routine  can  draw  91000  pixels/second  (91
  250. kilopixels?),   and   the   original  hipposcope  routine  can  draw  56000
  251. pixels/second  (on my MC68010 1mb chip 2mb fast A500).  The routines in HiP
  252. are  the  same,  I just reduced the amount of pixels.  I also managed to do
  253. the  whole  thing  with  just  one  system  call!   The  result:  four fast
  254. scoperoutines.
  255.  
  256. The  scopes  will  need 5kb of chip and 32kb of any memory for buffers, and
  257. are  run  with  priority  of  -5 so that they won't interfere with anything
  258. important.
  259.  
  260. PT replayer normal/mixing
  261. -------------------------
  262. Normal: Use normal Protracker replayer to play modules.
  263. Mixing: Use Guru's replayer to play modules (PT mod = 4ch FTM).
  264.     This way you can use those neat modes, eg listen Protracker modules
  265.         with real surround.
  266.  
  267. (Mixing) rates
  268. --------------
  269. With  these you can control the mixing rates.  S3M/FTM/MOD/MTM settings are
  270. the same.  The unit is kHz and the TFMX unit is unknown, probably kHz, too.
  271.  
  272.  See 'Music formats'. 
  273.  
  274. Guru's modes (mixing, S3M/FTM/MOD/MTM)
  275. --------------------------------------
  276.    1st box
  277.    ¯¯¯¯¯¯¯
  278.    System    Allow multitasking when playing.
  279.    Killer    Disable system and swallow all CPU to get better quality.
  280.         Stop playing with the left mousebutton.
  281.         The blue flickering represents the free CPU time.
  282.  
  283.    2nd box (Surround, Stereo, Mono, Real surround, 14-bit stereo)
  284.    ¯¯¯¯¯¯¯
  285.    Some different ways of playing. Neat.
  286.  
  287.    3rd box (Value 0-8)
  288.    ¯¯¯¯¯¯¯
  289.    This is the volumeboost. It makes the sound clearer and louder with 8 or
  290.    more channels.
  291.  
  292. Module dir - Select
  293. -------------------
  294. Here you can enter your module directory or select it with requester.
  295.  
  296. XPK id on/off
  297. -------------
  298. When  on, all XPKed files will be checked if they should be loaded in FAST.
  299.  
  300. Save, Use, Cancel
  301. -----------------
  302. I  guess  you can guess these.  If you close the prefs window, it's same as
  303. 'Cancel'ling.  The prefs-file will be saved in S:  directory.
  304.  
  305.  
  306. *******************
  307. * Module selector *
  308. *******************
  309. Here  you  can see the modulelist.  You can select a module by pressing the
  310. left mousebutton on it.
  311.  
  312. *********************
  313. * Right mousebutton *
  314. *********************
  315. Pressing  the  right  mousebutton  will  shrink the window so that only the
  316. titlebar will be shown.  Press again on the activated window to expand.
  317.  
  318. If  you  somehow  loose  the window, just load the program again.  If there
  319. already  was  one  HippoPlayer running, it's window will be popped to front
  320. and expanded.
  321.  
  322. ***********************
  323. * Commandline options *
  324. ***********************
  325. You can add modules or load a moduleprogram with commandline options.
  326.  
  327. Add modules to the list:
  328. HiP <file2> <file2> ... <file16>
  329.  
  330. All the files will be added to the list and the first one will be played.
  331.  
  332. Load a moduleprogram:
  333. HiP PRG <moduleprogram>
  334.  
  335. The  program  will  be  loaded and the first module will be played.  If the
  336. playmode  is  set  as  'Random',  then  a  random module will be picked and
  337. played.   This is a nice feature if you happen to have many modules on your
  338. hard your disk.
  339.  
  340.  
  341. ***********
  342. * History *
  343. ***********
  344.  
  345. v1.00    Works...
  346.     I couldn't check the bug I suspected because a friend of
  347.         mine wanted to upload the program everywhere. This bug causes
  348.     memory to get fragmented when loading XPK files.
  349.  
  350. v1.01    No major bugs left..
  351.  
  352. v1.10   · Removed some small bugs here and there.
  353.     · A description of the gadgets in the program.
  354.     · Support for multisong Protracker modules.
  355.         · Replayer which plays S3M/FTM/MOD/MTM modules, by Guru (jee).
  356.     · Load/save moduleprogram.
  357.     · Commandline options.
  358.     · Four scopes.
  359.     · Communication between most of HiP's processes. All windows except
  360.           reqtools requesters will be closed when the mainwindow is closed.
  361.     · Window positions will be saved in the prefs-file. Also the state
  362.       of the scope (on/off) will be saved.
  363.     · Doesn't interfere with serial transfers on slower Amigas anymore.
  364.           Exceptions are MED, TFMX, The Player 6.0A.
  365.           They use their own way of timing (level 6 here I come).
  366.         · Works correctly on both PAL and NTSC.
  367.     · Behaves more intelligently with bigger fonts, eh...
  368.     · If playingmode is 'Random', Next/Prev will randomize a new
  369.       module instead of what they would normally do.
  370.     · Removed a bug in ProTracker's arpeggio.
  371.     · Newlook propgadgets on Kickstarts 2.0+.
  372.  
  373. v1.11    · Now should work on 36/50/60/72Hz screens correctly.
  374.     · New icon.
  375.     · Filter control in Prefs.
  376.     · Doesn't try to open windows over screen borders.
  377.     · Info menu, in which option to show samplenames.
  378.     · TFMX channel autodetect.
  379.     · New PS3M -> Mixingrate: 5-56 kHz, volumeboost: 0-8
  380.     · Lotsa fixes'n stuff.
  381.  
  382. ********
  383. * .... * 
  384. ********
  385. The program was made by using the Asm-One v1.06.  Pure assembler 100%+++...
  386. My best regards go to Jarno Paananen!
  387.  
  388. If  anyone  possesses  any  kind of music by Chris Hülsbeck, especially the
  389. album  "Shades",  or  wants to swap modules (I've over 100Mb) or real music
  390. (hardrock,  heavy,  trash,  death), contact me!  Also normal stuff like bug
  391. reports, comments & suggestions could be sent to:
  392.  
  393.   Kari-Pekka Koljonen
  394.   Torikatu 31
  395.   40900 Säynätsalo
  396.   Finland
  397.   Phone: 941-3742699 / +358-41-3742699.
  398.